/*
 *  Copyright 2007 Blandware (http://www.blandware.com)
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package com.blandware.atleap.webapp.action.core.sequenceItem;

import com.blandware.atleap.common.Constants;
import com.blandware.atleap.model.core.Localizable;
import com.blandware.atleap.model.core.Sequence;
import com.blandware.atleap.model.core.SequenceItem;
import com.blandware.atleap.service.core.SequenceManager;
import com.blandware.atleap.webapp.action.core.BaseAction;
import com.blandware.atleap.webapp.form.core.SequenceItemForm;
import com.blandware.atleap.webapp.util.core.WebappConstants;
import com.blandware.atleap.webapp.util.core.WebappUtil;
import org.apache.commons.validator.GenericValidator;
import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;
import org.apache.struts.action.ActionMessage;
import org.apache.struts.action.ActionMessages;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

/**
 * <p>Prepares form bean to update sequence item.
 * </p>
 * <p><a href="CallUpdateSequenceItemAction.java.html"><i>View Source</i></a></p>
 * <p/>
 *
 * @author Roman Puchkovskiy <a href="mailto:roman.puchkovskiy@blandware.com">
 *         &lt;roman.puchkovskiy@blandware.com&gt;</a>
 * @version : $Revision: 1.5 $ : 2007/12/17 13:38:25 $
 * @struts.action path="/core/sequenceItem/callUpdate"
 * name="sequenceItemForm"
 * scope="request"
 * validate="false"
 * roles="core-sequenceItem-update, core-sequenceItem-view"
 * @struts.action-forward name="updateSequenceItem"
 * path=".core.sequenceItem.update"
 * @struts.action-forward name="listSequenceItems"
 * path="/core/sequenceItem/list.do"
 * redirect="false"
 * @struts.action-forward name="listSequences"
 * path="/core/sequenceItem/list.do"
 * redirect="false"
 */
public final class CallUpdateSequenceItemAction extends BaseAction {
	/**
	 * @param mapping  The ActionMapping used to select this instance
	 * @param form     The optional ActionForm bean for this request (if any)
	 * @param request  The HTTP request we are proceeding
	 * @param response The HTTP response we are creating
	 * @return an ActionForward instance describing where and how
	 *         control should be forwarded, or null if response
	 *         has already been completed
	 */
	public ActionForward execute(ActionMapping mapping, ActionForm form,
	                             HttpServletRequest request, HttpServletResponse response) throws Exception {

        HttpSession session = request.getSession();

        // Check whether it's normal edit (from list of sequence items) or
		// it was invoked from context menu
		String redirectUrl = request.getParameter("redirectUrl");
        if ( !GenericValidator.isBlankOrNull(redirectUrl) ) {
			// It was invoked from context menu
			session.setAttribute(WebappConstants.REDIRECT_URL_KEY, redirectUrl);
		}

        String requestUrl = (String) session.getAttribute(WebappConstants.REDIRECT_URL_KEY);

        SequenceItemForm sequenceItemForm = (SequenceItemForm) form;

		if ( isCancelled(request) ) {
            if ( !GenericValidator.isBlankOrNull(requestUrl) ) {
                session.removeAttribute(WebappConstants.REDIRECT_URL_KEY);
                return new ActionForward(requestUrl, true);
            }
            return mapping.findForward("listSequenceItems");
		}

		if ( !request.isUserInRole("core-sequenceItem-update") ) {
			response.sendError(HttpServletResponse.SC_FORBIDDEN);
			return null;
		}

        Long sequenceItemId;
        if ( !GenericValidator.isBlankOrNull(sequenceItemForm.getId()) ) {
            sequenceItemId = Long.valueOf(sequenceItemForm.getId());
        } else {
            if ( log.isWarnEnabled() ) {
                log.warn("Missing sequence item ID. Returning to index...");
            }
            if ( !GenericValidator.isBlankOrNull(requestUrl) ) {
                session.removeAttribute(WebappConstants.REDIRECT_URL_KEY);
                return new ActionForward(requestUrl, true);
            }
            return mapping.findForward("listSequenceItems");
        }

        // remove attribute 'inputId' from session, if it exists
		session.removeAttribute(WebappConstants.HTML_INPUT_TAG_ID_KEY);

		SequenceManager sequenceManager = (SequenceManager) getBean(Constants.SEQUENCE_MANAGER_BEAN);

        SequenceItem sequenceItem;
        Localizable owner;

        // retrieve requested sequence item
        sequenceItem = sequenceManager.retrieveSequenceItem(sequenceItemId);

        if ( sequenceItem == null ) {
            // sequence item not found. it might has already been deleted
            ActionMessages errors = new ActionMessages();
            errors.add("sequenceItemNotFound", new ActionMessage("core.sequenceItem.errors.notFound"));
            saveErrors(request, errors);
            if ( !GenericValidator.isBlankOrNull(requestUrl) ) {
                session.removeAttribute(WebappConstants.REDIRECT_URL_KEY);
                return new ActionForward(requestUrl, true);
            }
            return mapping.findForward("listSequenceItems");
        }

        Sequence sequence = sequenceItem.getSequence();
        String objectIdentifier;
        if (sequenceItem.getPage() != null) {
            objectIdentifier = sequenceItem.getPage().getUri();
            objectIdentifier = WebappUtil.computeURL(objectIdentifier, null, null,
                    null, null, request, response, false, false, false);
            String contextPath = request.getContextPath();
            if ("/".equals(contextPath)) {
                contextPath = "";
            }
            // removing context path and following slash
            objectIdentifier = objectIdentifier.substring(contextPath.length() + 1);
        } else {
            objectIdentifier = sequenceItem.getContentResource().getUri();
            // removing leading slash
            objectIdentifier = objectIdentifier.substring("/".length());
        }
        sequenceItemForm.setObjectIdentifier(objectIdentifier);
        sequenceItemForm.setVersion(sequenceItem.getVersion().toString());

        // export sequence into session
        session.setAttribute(WebappConstants.SEQUENCE_KEY, sequence);

        // get information about owner
        owner = sequence.getOwner();
        String ownerInfo = WebappUtil.getLocalizableInfo(owner, request);
        session.setAttribute(WebappConstants.OWNER_INFO_KEY, ownerInfo);

		// save transaction token in request
		saveToken(request);
        return mapping.findForward("updateSequenceItem");
	}
}